/*
  *
  *  *  Copyright 2014 Orient Technologies LTD (info(at)orientechnologies.com)
  *  *
  *  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  *  you may not use this file except in compliance with the License.
  *  *  You may obtain a copy of the License at
  *  *
  *  *       http://www.apache.org/licenses/LICENSE-2.0
  *  *
  *  *  Unless required by applicable law or agreed to in writing, software
  *  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  *  *  See the License for the specific language governing permissions and
  *  *  limitations under the License.
  *  *
  *  * For more information: http://www.orientechnologies.com
  *
  */
package com.orientechnologies.common.types;

/**
 * Modifiable value. Point to the real value. Useful to pass in method as parameter, letting the method to change. A sort of void*
 * of C language.
 * 
 * @author Luca Garulli (l.garulli--at--orientechnologies.com)
 * 
 */
public class ORef<T> {
  public T value;

  public ORef() {
  }

  public ORef(final T object) {
    this.value = object;
  }

  public ORef<T> clear() {
    value = null;
    return this;
  }

  @Override
  public String toString() {
    return value != null ? value.toString() : "ORef<null>";
  }
}
